Skip to main content

DescribeWhiteList

Description

No description for this api.

Request Method

POST

Request Path

/apsara/route/Ddosprivate/DescribeWhiteList

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
DestinationIpBODYstringNoNo sample value for this parameter.target IP.
TypeBODYintegerNoNo sample value for this parameter.whitelist types, including: 6: indicates that the host brute force cracked the whitelist 12: indicates bwaf source IP whitelist 15: indicates application attack whitelist
UsernameBODYstringNoNo sample value for this parameter.username.
regionIdBODYstringYesNo sample value for this parameter.region id
SourceIpStrBODYstringNoNo sample value for this parameter.source IP.
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
DestinationIpstringno demo valuetarget IP.
TotalCountintegerno demo valuereturns the total number of pages.
Typeintegerno demo valuewhitelist type: 6: indicates that the host brute force cracked the whitelist 12: indicates bwaf source IP whitelist 15: indicates application attack whitelist
SourceIpstringno demo valuesource IP.
RequestIdstringno demo valuerequest ID.
PageSizeintegerno demo valuepage displays the maximum number of records.
CurrentPageintegerno demo valuecurrently returns page number.
Usernamestringno demo valueusername.
WhiteListslistno demo valuewhitelist list, see the following parameter description for specific sub-items.
Idintegerno demo valuewhitelist record ID.

Example

Successful Response example

{
"DestinationIp":"no demo value",
"TotalCount":"no demo value",
"Type":"no demo value",
"SourceIp":"no demo value",
"RequestId":"no demo value",
"PageSize":"no demo value",
"CurrentPage":"no demo value",
"Username":"no demo value",
"WhiteLists":"no demo value",
"Id":"no demo value"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}